package com.csun.cmny.provider.service;

import com.csun.cmny.base.dto.LoginAuthDto;
import com.csun.cmny.provider.dto.DeploymentDto;
import org.activiti.engine.repository.Deployment;
import org.activiti.engine.runtime.ProcessInstance;
import org.activiti.engine.task.Task;

import java.util.Map;

/**
 * @Auther: chisj chisj@foxmal.com
 * @Date: 2019-05-29 09:39
 * @Description: the class omc activiti service
 */
public interface OmcActivitiService {

    /**
     * 创建流程部署
     *
     * @param deploymentDto deployment dto
     * @param loginAuthDto  login auth dto
     *
     * @return  the deployment
     */
    Deployment createDeployment(DeploymentDto deploymentDto, LoginAuthDto loginAuthDto);

    /**
     * 删除流程部署
     *
     * @param processKey    process key
     * @param groupId  the group id
     */
    void deleteDeployment(String processKey, Long groupId);

    /**
     * 启动流程实例
     *
     * @param processKey    流程key
     * @param variables     要传递的变量
     * @param groupId       组织Id
     *
     * @return  流程实例
     */
    ProcessInstance startProcessInstanceByKeyAndTenantId(String processKey, Map<String, Object> variables, Long groupId);

    /**
     * 根据流程实例Id获取当前流程任务
     *
     * @param processInstanceId 流程实例Id
     *
     * @return  任务
     */
    Task getTaskByProcessInstanceId(String processInstanceId);

    /**
     * 完成任务
     *
     * @param task  待完成的任务
     */
    void completeTask(Task task);

    /**
     * 添加任务批注
     *
     * @param task                  待添加批注的任务
     * @param authenticatedUserId   执行人
     * @param message               批注
     */
    void addTaskComment(Task task, String authenticatedUserId, String message);

    /**
     * 关闭流程实例
     *
     * @param processInstanceId 流程实例Id
     * @param deleteReason      流程实例理由
     */
    void deleteProcessInstance(String processInstanceId, String deleteReason);
}
